home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / LANG / SCHEME / GNU / SCM4E1 / !Scm / slib / README < prev    next >
Text File  |  1994-03-07  |  7KB  |  155 lines
  1. This directory contains the distribution of the Scheme Library slib2a.
  2. Slib conforms to Revised^4 Report on the Algorithmic Language Scheme
  3. and the IEEE P1178 specification.  Slib supports Unix and similar
  4. systems, VMS, and MS-DOS.
  5.  
  6. The maintainer can be reached at jaffer@ai.mit.edu or
  7. Aubrey Jaffer, 84 Pleasant St., Wakefield MA 01880.
  8.  
  9.                    MANIFEST
  10.  
  11.   `README' is this file.  It contains a MANIFEST, INSTALLATION
  12.     INSTRUCTIONS, and proposed coding standards.
  13.   `ChangeLog' documents changes to slib.
  14.   `slib.texi' has documentation on library packages in TexInfo format.
  15.  
  16.   `Template.scm' Example configuration file.  Copy and customize to
  17.     reflect your system.
  18.   `chez.init' is a configuration file for Chez Scheme.
  19.   `elk.init' is a configuration file for ELK 2.1
  20.   `gambit.init' is a configuration file for Gambit Scheme.
  21.   `macscheme.init' is a configuration file for MacScheme.
  22.   `mitscheme.init' is a configuration file for MIT Scheme.
  23.   `mitcomp.pat' is a patch file which adds definitions to SLIB files
  24.     for the MitScheme compiler.
  25.   `scheme2c.init' is a configuration file for DEC's scheme->c.
  26.   `scheme48.init' is a configuration file for Scheme48.
  27.   `t3.init' is a configuration file for T3.1 in Scheme mode.
  28.   `vscm.init' is a configuration file for VSCM.
  29.   `require.scm' has code which allows system independent access to
  30.     the library files.
  31.  
  32.   `format.scm' has Common-Lisp style format.
  33.   `formatst.scm' has code to test format.scm
  34.   `pp.scm' has pretty-print.
  35.   `ppfile.scm' has pprint-file and pprint-filter-file.
  36.   `obj2str.scm' has object->string.
  37.   `strcase.scm' has functions for manipulating the case of strings.
  38.   `genwrite.scm' has a generic-write which is used by pp.scm,
  39.     pp2str.scm and obj2str.scm
  40.   `stdio.scm' has printf, fprintf, and sprintf compatible with C.
  41.   `lineio' has line oriented input/output functions.
  42.   `debug.scm' has qp, a printer save for circular structures, tracef
  43.     and untracef for tracing function execution, and break and
  44.     continue.
  45.   `test.scm' has routines useful for testing and reporting problems.
  46.   `strport.scm' has routines for string-ports.
  47.  
  48.   `alist.scm' has functions accessing and modifying association lists.
  49.   `hash.scm' defines hash, hashq, and hashv.
  50.   `hashtab.scm' has hash tables.
  51.   `logical.scm' emulates 2's complement logical operations.
  52.   `random.scm' has random number generator compatible with Common Lisp.
  53.   `randinex.scm' has inexact real number distributions.
  54.   `prime.scm' has prime? and factor.
  55.   `charplot.scm' has procedure for plotting on character screens.
  56.   `plottest.scm' has code to test charplot.scm.
  57.   `tek40.scm' has routines for Tektronix 4000 series graphics.
  58.   `tek41.scm' has routines for Tektronix 4100 series graphics.
  59.   `getopt.scm' has posix-like getopt for parsing command line arguments. 
  60.  
  61.   `record.scm' a MITScheme user-definable datatypes package
  62.   `promise.scm' has code from R4RS for supporting DELAY and FORCE.
  63.  
  64.   `repl.scm' has a read-eval-print-loop.
  65.   `defmacex.scm' has defmacro:expand*.
  66.   `mbe.scm' has "Macro by Example" define-syntax.
  67.   `scmacro.scm' is a syntactic closure R4RS macro package.
  68.     r4rsyn.scm, synclo.scm, synrul.scm have syntax definitions
  69.     and support.
  70.   `scmactst.scm' is code for testing SYNTACTIC CLOSURE macros.
  71.   `scainit.scm' is a syntax-case R4RS macro package.
  72.     scaglob.scm scamacr.scm scaoutp.scm scaexpp.scm have
  73.     syntax definitions and support.  `syncase.sh' is a shell
  74.     script for producing the SLIB version from the original.
  75.   `macwork.scm' is a "Macros that work" package.
  76.     mwexpand.scm mwdenote.scm mwsynrul.scm have support.
  77.     mwtest.scm is tests for Macros that work.
  78.   `macrotst.scm' is code from R4RS for testing macros.
  79.  
  80.   `values.scm' is multiple values.
  81.   `queue.scm' has queues and stacks.
  82.   `object.scm' is object oriented programming (using no macros).
  83.   `yasos.scm' is object oriented programming (using R4RS macros).
  84.   `collect.scm' is collection operators (like CL sequences).
  85.   `priorque.scm' has code and documentation for priority queues.
  86.   `rbtree.scm' has red-black trees.
  87.   `rbtest.scm' tests red-black trees.
  88.   `process.scm' has multi-processing primitives.
  89.   `array.scm' has multi-dimensional arrays and sub-arrays.
  90.   `arraymap.scm' has array-map!, array-for-each, and array-indexes.
  91.  
  92.   `sort.scm' has sorted?, sort, sort!, merge, and merge!
  93.   `comlist.scm' has many common list and mapping procedures.
  94.   `tree.scm' has functions dealing with trees.
  95.  
  96.   `sc4opt.scm' has optional rev4 procedures.
  97.   `sc4sc3.scm' has procedures to make a rev3 implementation run rev4
  98.     code. 
  99.   `sc2.scm' has rev2 procedures eliminated in subsequent versions.
  100.   `sc3.scm' has rev3 procedures eliminated in subsequent versions.
  101.   `mularg.scm' redefines - and / to take more than 2 arguments.
  102.   `mulapply.scm' redefines apply to take more than 2 arguments.
  103.   `ratize.scm' has function rationalize from Revised^4 spec.
  104.   `trnscrpt.scm' has transcript-on and transcript-off from Revised^4 spec.
  105.   `withfile.scm' has with-input-from-file and with-output-to-file from R4RS.
  106.   `dynwind.scm' has proposed dynamic-wind from R5RS.
  107.   `dwindtst.scm' has routines for characterizing dynamic-wind.
  108.   `dynamic.scm' has proposed DYNAMIC data type.
  109.   `fluidlet.scm' has fluid-let syntax.
  110.   `struct.scm' has defmacros which implement RECORDS from the book:
  111.     "Essentials of Programming Languages".
  112.   `structure.scm' has syntax-case macros for the same.
  113.   `structst.scm' has test code for struct.scm and structure.scm.
  114.  
  115.               INSTALLATION INSTRUCTIONS
  116.  
  117. Check the manifest to see if a configuration file for your Scheme
  118. implementation has already been created.  If so, customize it and use
  119. it.  If not, you will have to create one.  Please mail new working
  120. configuration files to jaffer@ai.mit.edu so that they can be included
  121. in the SLIB distribution.
  122.  
  123. Template.scm is an example configuration file.  The comments inside
  124. will direct you on how to customize it to reflect your system.  Your
  125. customized version should then be loaded as part of your scheme
  126. implementation's initialization.  It will load "require.scm" from the
  127. library; this will allow the use of PROVIDE, PROVIDED?, and REQUIRE
  128. along with the VICINITY functions (all documented in require.doc).
  129. The rest of the library will then be accessible in a system
  130. independent fashion.
  131.  
  132.                CODING STANDARDS
  133.  
  134. All library packages are written in IEEE P1178 Scheme and assume that
  135. a configuration file and require.scm package have already been
  136. loaded.  Other versions of Scheme can be supported in library packages
  137. as well by using (PROVIDED? 'REV3-REPORT) or (REQUIRE 'REV3-REPORT).
  138.  
  139. Require.scm defines *catalog*, an alist of module names and
  140. filenames.  When a new package is added to the library an entry should
  141. be added to require.scm.  Local packages can also be added to
  142. *catalog* and even shadow entries already in the table.
  143.  
  144. The module name and `:' should prefix each symbol defined in the
  145. package.  Definitions for external use should then be exported by
  146. having (define foo module-name:foo).
  147.  
  148. Submitted packages should not duplicate routines which are already in
  149. SLIB files.  Use REQUIRE to force those features to be supported in
  150. your package.  Care should be taken that there are no circularities in
  151. the REQUIREs and LOADs between the library packages.
  152.  
  153. Documentation should be provided in Emacs Texinfo format if possible;
  154. But documentation must be provided.
  155.